pipenv installation instructions#202
Conversation
|
Can you please add |
|
Added. |
README.md
Outdated
| * `make test` | ||
| ```bash | ||
| pipenv shell | ||
| pipenv install --dev |
There was a problem hiding this comment.
This should probably be pipenv sync --dev.
install will re-resolve all the dependencies if packages have been updated, potentially leading to a problem.
sync installs whatever is in Pipfile.lock(which is what we want) .
https://pipenv.pypa.io/en/latest/advanced/#using-pipenv-for-deployments
README.md
Outdated
|
|
||
| Now, make sure you're running python 3.8 and that your `pipenv` actually uses it! It may use packages from `$HOME/.local/lib/python3.7` even when started with `pipenv --python 3.8`. To combat this, (re)install it using: | ||
| ``` | ||
| /path/to/python3.8 -m pip install pipenv |
There was a problem hiding this comment.
A better practice would be to use pipx or brew to install pipenv
https://pipxproject.github.io/pipx/
https://pipenv.pypa.io/en/latest/install/#homebrew-installation-of-pipenv
There was a problem hiding this comment.
But then you need to install pipx in the first place, which is yet another thing which can go wrong. So when having the choice - to get X done:
- you need to have Y.
- just use tools you already have.
I prefer the 2., unless given sufficiently strong arguments for 1.
Anyway I'm not much of a python developer, and I don't really want to become one, so it's up to you - change it the way you like. That applies to both or your remarks.
There was a problem hiding this comment.
Arguments about the best way to install pipenv aside...
What you've written here is factually incorrect.
You don't need to re-install pipenv in order to have it create a 3.8 virtual environment.
pipenv installed via 3.6 can still create and use a 3.8 environment as long as 3.8 is installed and on the PATH
https://pipenv.readthedocs.io/en/latest/basics/#specifying-versions-of-python
You don't need to include detailed instructions about brew or pipx installations.
Something simple with links to more detailed instructions should be sufficient.
- Make sure you have
python3.8installed and on yourPATH. - Install the
pipenvdependency manager- with pipx
$ pipx install pipenv - with Homebrew/Linuxbrew
$ brew install pipenv - with pip/pip3 directly
$ pip install --user pipenv
- with pipx
tests/conftest.py
Outdated
| The test client uses the requests library for making http requests. | ||
| """ | ||
| return TestClient(APP) | ||
|
|
There was a problem hiding this comment.
We now require that the code be formatted with the black code formatter.
That's why the build is failing.
You can do pipenv run fmt if your branch is up to date.
or black . -l 120 directly
There was a problem hiding this comment.
Ups, that was a mistake. I didn't want to change the tests/conftest.py. Sorry
Kilo59
left a comment
There was a problem hiding this comment.
Instructions contain misleading information about pipenv usage.
README.md
Outdated
|
|
||
| Now, make sure you're running python 3.8 and that your `pipenv` actually uses it! It may use packages from `$HOME/.local/lib/python3.7` even when started with `pipenv --python 3.8`. To combat this, (re)install it using: | ||
| ``` | ||
| /path/to/python3.8 -m pip install pipenv |
There was a problem hiding this comment.
Arguments about the best way to install pipenv aside...
What you've written here is factually incorrect.
You don't need to re-install pipenv in order to have it create a 3.8 virtual environment.
pipenv installed via 3.6 can still create and use a 3.8 environment as long as 3.8 is installed and on the PATH
https://pipenv.readthedocs.io/en/latest/basics/#specifying-versions-of-python
You don't need to include detailed instructions about brew or pipx installations.
Something simple with links to more detailed instructions should be sufficient.
- Make sure you have
python3.8installed and on yourPATH. - Install the
pipenvdependency manager- with pipx
$ pipx install pipenv - with Homebrew/Linuxbrew
$ brew install pipenv - with pip/pip3 directly
$ pip install --user pipenv
- with pipx
Whatever. Correct me as you please. Write there what you want and need. |
No description provided.